/*
 * MIT License
 *
 * Copyright (c) 2020 wen.gu <454727014@qq.com>
 *
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 *
 * The above copyright notice and this permission notice shall be included in all
 * copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
 * SOFTWARE.
 */

 /***************************************************************************
 * Name: file_storage.h
 *
 * Purpose: file storage(persistency) implementation for base library
 *
 * Developer:
 *   wen.gu , 2019-10-11
 *
 * TODO:
 *
 ***************************************************************************/

 /******************************************************************************
 **    INCLUDES
 ******************************************************************************/
#ifndef __PANDA_PER_FILE_STORAGE_H__
#define __PANDA_PER_FILE_STORAGE_H__

#include <memory>

#include "panda/core/types.h"
#include "panda/core/errors.h"

#include "panda/per/file_accessor.h"

namespace panda
{
namespace per
{
/******************************************************************************
 **    MACROS
 ******************************************************************************/

 /******************************************************************************
 **    TYPE DEFINITIONS
 ******************************************************************************/


using FileNameArray = std::vector<std::string>;
using KeyType = const std::string;

 /******************************************************************************
 **    CLASSES/FUNCTIONS DEFINITIONS
 ******************************************************************************/


class CORE_CLASS FileStorage final
{
public:
    using PandaErrc = panda::core::PandaErrc;
public:
    static std::shared_ptr<FileStorage> OpenFileStorage(const std::string& fs);
    ~FileStorage();

protected:
    FileStorage(const std::string& fs);


public:
    FileStorage(const FileStorage&) = delete;
    FileStorage& operator= (const FileStorage&) = delete;

public:
    FileNameArray getAllFileNames();
    PandaErrc deleteFile(const std::string& fn);
    bool fileExists(const std::string& fn);

    PandaErrc resetFile(const std::string& fn);
    PandaErrc resetAllFiles();
public:

    std::unique_ptr<FileAccessor> openFileReadWrite(const std::string& fn);
    std::unique_ptr<FileAccessor> OpenFileReadOnly(const std::string& fn);

private:
    class impl;
    std::unique_ptr<impl> mImpl;
};


} /** namespace per */
} /** namespace panda*/

#endif /** !__PANDA_PER_FILE_STORAGE_H__ */
